docs: add pre-commit setup to bootstrap and deduplicate contributing guides#1946
Open
bearomorphism wants to merge 1 commit intomasterfrom
Open
docs: add pre-commit setup to bootstrap and deduplicate contributing guides#1946bearomorphism wants to merge 1 commit intomasterfrom
bearomorphism wants to merge 1 commit intomasterfrom
Conversation
328034d to
70821dc
Compare
…guides - Add missing setup-pre-commit step to AGENTS.md bootstrap - Clarify what prek is with a link to its repository - Add cross-references between AGENTS.md and contributing.md - Refactor contributing_tldr.md into a pure command cheat sheet, removing duplicated prerequisites/setup already in contributing.md - Fix bare mypy/pytest commands to use uv run prefix - Fix anchor link to prerequisites section Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
70821dc to
14ae7d0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Add missing pre-commit hook installation instructions and deduplicate the three contributor-facing docs (AGENTS.md, contributing.md, contributing_tldr.md).
uv run poe setup-pre-commitstep to AGENTS.md bootstrapprekis with a link to its repositorycontributing_tldr.mdinto a pure command cheat sheet, removing duplicated prerequisites/setup already incontributing.mdmypy/pytestcommands to useuv runprefixChecklist
Was generative AI tooling used to co-author this PR?
Generated-by: GitHub Copilot following the guidelines
Code Changes
Add test cases to all the changes you introduce(docs-only change)uv run poe alllocally to ensure this change passes linter check and testsDocumentation Changes
uv run poe doclocally to ensure the documentation pages renders correctlyExpected Behavior
All three docs cross-reference
contributing.mdas the single source of truth for prerequisites and setup. No duplicated content across files.Steps to Test This Pull Request
uv run mkdocs build --strict— should build with no broken link warningssetup-pre-commitAdditional Context
The
preklink was initially pointing tocommitizen-tools/prek(404); corrected toj178/prek.